Skip to content

Create CHANGELOG.md #61

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Jan 31, 2022
Merged

Conversation

Archmonger
Copy link
Contributor

@Archmonger Archmonger requested a review from a team as a code owner January 31, 2022 03:17
@Archmonger
Copy link
Contributor Author

This changelog is ready, but I strongly suggest merging #58 before our formal release.

Some Django beginners had some issues installing IDOM, and that PR adds the detail needed to resolve that.

@Archmonger
Copy link
Contributor Author

Did some more minor changes after re-reading. I think I'm satisfied with it now. Feel free to review.

@rmorshea
Copy link
Contributor

Should there be an automated way to enforce additions to the changelog? Maybe something like this?

@rmorshea
Copy link
Contributor

That can be added later though in a different PR.

@Archmonger Archmonger merged commit 6b430e5 into reactive-python:main Jan 31, 2022
@Archmonger
Copy link
Contributor Author

I was thinking of that too, however, it might get annoying for minor PRs such as readme spelling fixes to be forced update the changelog.

If we want to do this, we can do something about that via the skipLabels option within that CI workflow. Like PRs tagged with documentation can be skipped, and then optionally we can add a no-changelog tag on top of that.

But all of that might end up being more effort than manually enforcing changelog updates.

@Archmonger Archmonger deleted the changelog branch January 31, 2022 03:53
@rmorshea
Copy link
Contributor

Since it'll probably just be us contributing for the time being it's probably not that important to do now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Changelog
2 participants